RHDHBUGS-2128 part 2, Add missing $ prompt in code blocks for command examples #1681
+93
−93
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Collaborator
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1681/ @ 01/15/26 19:57:23 |
deerskindoll
approved these changes
Jan 19, 2026
Member
deerskindoll
left a comment
deerskindoll
left a comment
There was a problem hiding this comment.
a couple of nits, otherwise lgtm
| = Populating the API Definition tab in {product-very-short} API entities | ||
|
|
||
| Since {rhoai-short} does not expose the OpenAPI specification by default, the AI platform engineer can take the following steps to provide this valuable information: | ||
| Because {rhoai-short} does not expose the OpenAPI specification by default, the AI platform engineer can take the following steps to provide this valuable information: |
Member
There was a problem hiding this comment.
Suggested change
| Because {rhoai-short} does not expose the OpenAPI specification by default, the AI platform engineer can take the following steps to provide this valuable information: | |
| Because {rhoai-short} does not expose the OpenAPI specification by default, the AI platform engineer can take the following steps to provide this information. |
|
|
||
| .Procedure | ||
|
|
||
| . Retrieve OpenAPI JSON: Use a tool like `curl` to fetch the specification directly from the running endpoint of the AI model server. The following command provides the precise endpoint (`/openapi.json`) and shows how to include a `Bearer` token if the model requires authentication for access. |
Member
There was a problem hiding this comment.
Suggested change
| . Retrieve OpenAPI JSON: Use a tool like `curl` to fetch the specification directly from the running endpoint of the AI model server. The following command provides the precise endpoint (`/openapi.json`) and shows how to include a `Bearer` token if the model requires authentication for access. | |
| . Retrieve OpenAPI JSON: Use a tool such as `curl` to fetch the specification directly from the running endpoint of the AI model server. The following command provides the precise endpoint (`/openapi.json`) and shows how to include a `Bearer` token if the model requires authentication for access. |
| $ oc logs -c install-dynamic-plugins deployment/<your {product-very-short} deployment> | ||
| ---- | ||
|
|
||
| The `install-dynamic-plugin` logs allow you to check the following installation logs for successful logs: |
Member
There was a problem hiding this comment.
Suggested change
| The `install-dynamic-plugin` logs allow you to check the following installation logs for successful logs: | |
| The `install-dynamic-plugin` logs let you to check the following installation logs for successful logs: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RHDHBUGS-2128 part 2, Add missing $ prompt in code blocks for command examples
Description: This PR adds the $ prompt for code blocks in 31 files.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
main, 1.9, 1.8, 1.7, 1.6
Issue:
https://issues.redhat.com/browse/RHDHBUGS-2128
Preview:
Files changed:
modules/proc-create-plugin.adoc
modules/techdocs/proc-techdocs-addon-create.adoc
modules/techdocs/proc-techdocs-addon-install-third-party.adoc
modules/upgrade/proc-upgrade-rhdh-helm.adoc
modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc
modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-partial.adoc
modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-full.adoc
modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-partial.adoc
modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc
modules/orchestrator/proc-upgrading-the-orchestrator-plugin.adoc
modules/orchestrator/ref-orchestrator-resource-limits.adoc
modules/orchestrator/snip-installing-the-orchestrator-common-steps.adoc
modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc
modules/orchestrator/proc-building-the-01-basic-workflow.adoc
modules/orchestrator/proc-creating-and-running-workflows.adoc
modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc
modules/orchestrator/proc-enable-orchestrator-plugin.adoc
modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc
modules/orchestrator/proc-helper-script-overview.adoc
modules/openshift-ai-connector-for-rhdh/proc-populating-the-api-definition-tab.adoc
modules/openshift-ai-connector-for-rhdh/proc-troubleshooting-connector-functionality.adoc
modules/openshift-ai-connector-for-rhdh/ref-openshift-ai-model-registry-and-model-catalog-queries.adoc
modules/observe/adoption-insights/proc-customize-adoption-insights.adoc
modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc
modules/observe/proc-configure-annotations-for-aks-monitoring.adoc
modules/observe/proc-configuring-annotations-for-monitoring-with-amazon-prometheus-by-using-the-helm-chart.adoc
modules/observe/proc-enabling-azure-monitor-metrics.adoc
modules/observe/proc-forward-audit-log-splunk.adoc
modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc
modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc
modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc